/**
 * Copyright (c) 2006-2012 Las Venturas Playground, LVP Mineground
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package mineground.core;

/**
 * Define a list of messages which can be passed as Messages through the Message Loop. As the
 * handlers are being invoked through reflection, the expected parameters are not known during the
 * time of posting the message. Be sure to document the expected parameters for each message.
 * 
 * Messages in this enum will be grouped by their purpose, with no required sort in place. Please
 * either add your new message to the right section, or create a new section if you feel that to
 * be appropriate.
 */
public enum Message {
    
    /** Events which will be spawned by the server, for example player actions. **/
    
    PlayerJoinEvent, /* [Player player] */
    PlayerQuitEvent, /* [Player player, String message] */
    PlayerChatEvent, /* [Player player, String message] */
    
    /** Example messages used for testing, will be cleaned up later. **/
    
    PlayerLoginEvent, /* [String text, int value] */
    PerformanceTest, /* [int unused] */
    
}